Repository navigation
Add valkey-large-object command support - #764
Draft
kevinmcgehee wants to merge 1 commit into
Draft
kevinmcgehee wants to merge 1 commit into
kevinmcgehee wants to merge 1 commit into
Conversation
Read the BLOB.* command JSON files from valkey-io/valkey-large-object, show the module name on its command pages, and add its menu file from valkey-doc modules-nav/ to the documentation menu with a module badge. Show the version notice from modules.json before the usage of commands of modules that have one. Signed-off-by: Kevin McGehee <mcgehee@amazon.com>
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add the valkey-large-object module to the documentation site, in the same way as valkey-bloom, valkey-json and valkey-search:
build/init-commands.shtakes a sixth argument, the module'ssrc/commandsdirectory, and links it asbuild-large-object-command-json.config.tomlgetscommand_large_object_json_path, and the command page, the command index and the docs menu read command metadata from it. The CI build action (.github/actions/build-site/action.yml) checks outvalkey-io/valkey-large-objectand passes the new argument.BLOB.*page shows the "Module: valkey-large-object" row, like the other modules.modules.jsoncan have aversion_noticetext and acommand_prefix. The command page shows that text before Usage on the module's command pages. The template has no module-specific text. Only valkey-large-object uses it now: "valkey-large-object is at version 0.x. Commands, arguments, replies, and configuration can change before version 1.0."modules-nav/valkey-large-object.yml(from valkey-doc) adds a "Large object" section with a module badge.README.mdand.gitignoreare updated for the new argument and link.Dependencies and merge order
src/commands/blob.*.json.init-commands.shstops if the sixth directory does not exist, so the CI build of this PR needs those files on the module's default branch.BLOB.*command pages, the topic pages, themodules.jsonentry and themodules-nav/file. If Remove intro paragraph above demo video #552 merges before this PR is live, its command pages show "ERROR. Command JSON Not loaded."Testing
Built locally with Zola 0.23.6, with valkey-doc from #552 and the command JSON from #197:
/commands/shows the "Large object" group with the six commands./commands/blob.tcp_set/shows the version notice before Usage, the Reply section, and the Module row, with no "Command JSON Not loaded"./commands/bf.add/and the other module and core command pages show no notice.Issues Resolved
None.
Check List
--signoffBy submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.